<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>xpc (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">net.xpc</span>
</div>

<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="class_goog_net_xpc_CrossPageChannel.html">
          goog.net.xpc.CrossPageChannel</a><br/>
        <div class="class-details">A communication channel between two documents from different domains.
Provides asynchronous messaging.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_net_xpc_FrameElementMethodTransport.html">
          goog.net.xpc.FrameElementMethodTransport</a><br/>
        <div class="class-details">Frame-element method transport.

Firefox allows a document within an iframe to call methods on the
iframe-element added by the containing document.
NOTE(user): Tested in all FF versions starting from 1.0</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_net_xpc_IframePollingTransport.html">
          goog.net.xpc.IframePollingTransport</a><br/>
        <div class="class-details">Iframe polling transport. Uses hidden iframes to transfer data
in the fragment identifier of the URL. The peer polls the iframe's location
for changes.
Unfortunately, in Safari this screws up the history, because Safari doesn't
allow to call location.replace() on a window containing a document from a
different domain (last version tested: 2.0.4).</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_net_xpc_IframeRelayTransport.html">
          goog.net.xpc.IframeRelayTransport</a><br/>
        <div class="class-details">Iframe relay transport. Creates hidden iframes containing a document
from the peer's origin. Data is transferred in the fragment identifier.
Therefore the document loaded in the iframes can be served from the
browser's cache.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_net_xpc_NativeMessagingTransport.html">
          goog.net.xpc.NativeMessagingTransport</a><br/>
        <div class="class-details">The native messaging transport

Uses document.postMessage() to send messages to other documents.
Receiving is done by listening on 'message'-events on the document.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_net_xpc_NixTransport.html">
          goog.net.xpc.NixTransport</a><br/>
        <div class="class-details">NIX method transport.

NOTE(user): NIX method tested in all IE versions starting from 6.0.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_net_xpc_Transport.html">
          goog.net.xpc.Transport</a><br/>
        <div class="class-details">The base class for transports.</div>
 </div>
   
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>



<h2>Enumerations</h2>






<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.ChannelStates"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">ChannelStates</span>
        : 
     </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

     <div class="entryDetails">
       <div class="detailsSection">
          <b>Constants:</b>
          <table class="horiz-rule">
            <tbody>
              <tr><td>
                <span class="entryName">
                  CLOSED
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  CONNECTED
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  NOT_CONNECTED
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
           </tbody>
         </table>
       </div>
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line209">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.CrossPageChannelRole"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">CrossPageChannelRole</span>
        : 
     </div>


     <div class="entryOverview">
       The role of the peer.
     </div>

     <div class="entryDetails">
       <div class="detailsSection">
          <b>Constants:</b>
          <table class="horiz-rule">
            <tbody>
              <tr><td>
                <span class="entryName">
                  OUTER
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  INNER
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
           </tbody>
         </table>
       </div>
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_crosspagechannelrole.js.source.html#line27">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.TransportTypes"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">TransportTypes</span>
        : 
     </div>


     <div class="entryOverview">
       Enum used to identify transport types.
     </div>

     <div class="entryDetails">
       <div class="detailsSection">
          <b>Constants:</b>
          <table class="horiz-rule">
            <tbody>
              <tr><td>
                <span class="entryName">
                  FRAME_ELEMENT_METHOD
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  IFRAME_RELAY
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  FLASH
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  IFRAME_POLLING
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  NATIVE_MESSAGING
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
              <tr><td>
                <span class="entryName">
                  NIX
                </span>
                <div class="entryOverview">
                  <span class='nodesc'>No description.</span>
                </div>
             </td></tr>
           </tbody>
         </table>
       </div>
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line56">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.net.xpc.getRandomString"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">getRandomString<span class="args">(<span class="arg">length</span>,&nbsp;<span class="arg">opt_characters</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
      </div>


     <div class="entryOverview">
       Returns a random string.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">length</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
        <div class="entryOverview">How many characters the string shall contain.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_characters</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span><span>&nbsp;|&nbsp;</span><span class="type">undefined</span>)</div>
        <div class="entryOverview">The characters used.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>&nbsp;
            The random string.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line268">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



  <h2>Global Properties</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.CfgFields"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">CfgFields</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       Field names used on configuration object.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line88">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.SETUP"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">SETUP</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       Transport signaling message: setup.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line228">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.xpc.SETUP_ACK_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">SETUP_ACK_</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       Transport signaling message: setup acknowledgement.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line243">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.SETUP_ACK_NTPV2"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">SETUP_ACK_NTPV2</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       Transport signaling message: setup acknowledgement.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line250">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.SETUP_NTPV2"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">SETUP_NTPV2</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       Transport signaling message: setup for native transport protocol v2.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line235">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.net.xpc.TRANSPORT_SERVICE_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">TRANSPORT_SERVICE_</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The name of the transport service (used for internal signalling).
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line221">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.TransportNames"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">TransportNames</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       Enum containing transport names. These need to correspond to the
transport class names for createTransport_() to work.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line71">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.UriCfgFields"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">UriCfgFields</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       Config properties that need to be URL sanitized.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line197">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.channels"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">channels</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>,(<span class="type"><a href="class_goog_net_xpc_CrossPageChannel.html">goog.net.xpc.CrossPageChannel</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)&gt;<span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       Object holding active channels.
Package private. Do not call from outside goog.net.xpc.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line259">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>





  <a name="goog.net.xpc.logger"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">logger</span>
        : <div class="fullType">(<span class="type"><a href="class_goog_debug_Logger.html">goog.debug.Logger</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       The logger.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line292">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.net.xpc.randomStringCharacters_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.net.xpc.</span><span class="entryName">randomStringCharacters_</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The default characters used for random string generation.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_net_xpc_xpc.js.source.html#line284">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>
      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Package net</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">Package Reference</h2>
            <div id="sideTypeIndex" rootPath="" current="net.xpc"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
